/*
 * The contents of this file are subject to the terms of the Common Development and
 * Distribution License (the License). You may not use this file except in compliance with the
 * License.
 *
 * You can obtain a copy of the License at legal/CDDLv1.0.txt. See the License for the
 * specific language governing permission and limitations under the License.
 *
 * When distributing Covered Software, include this CDDL Header Notice in each file and include
 * the License file at legal/CDDLv1.0.txt. If applicable, add the following below the CDDL
 * Header, with the fields enclosed by brackets [] replaced by your own identifying
 * information: "Portions copyright [year] [name of copyright owner]".
 *
 * Copyright 2015-2016 ForgeRock AS.
 */

package org.forgerock.openam.sm.datalayer.api;

/**
 * An interface for executing token tasks against a data layer.
 */
public interface TaskExecutor {

    /**
     * Executes the task for the given tokenId.
     * @param tokenId The token the task is in reference to. May be null in the case of query.
     * @param task The task to be executed.
     */
    void execute(String tokenId, Task task) throws DataLayerException;

    /**
     * If the executor needs to do anything to start up it should be done here. Clients should
     * call this method after obtaining a reference to the executor.
     */
    void start() throws DataLayerException;
}
